Pooka SDK API Reference

Table of Contents

Welcome to Pooka SDK® API Reference!

The Pooka SDK® API reference provides a reference to all public APIs available to utilize the power of Pooka SDK®.
To have a easy jumpstart on Pooka SDK® application development, It is also highly recommended to read Pooka SDK® Developer's Guide before start coding. Particularly, the following topics are important:



Tips of Using this API Reference

Special Annotations

When using This API reference, pay attention on the special annotations represented by small colored tabs:

Tab  
 Note  This is a generic note requests developer pay attention
Caution This is a caution note requests developer pay extra attention
Platform This is a cross-platform note gives extra information on each platforms or some platform related issues that developers need to take care
 Tip  This is a tip shows generic suggestions for coding efficiency, application performance or better application design
This is a link gives information with more details once expanded
 Sample Project  This is a link to the relevant sample project

Get Information Efficiently

Using "Namespaces" menu on navigation bar can quickly go to the namespace list page.
Using "Classes" menu on navigation bar can quickly go to the class list page.
The most efficient way to go to the page of a specific class is search by the class name in search box.



Terms Used in API Reference

  • Wide-char character: used to refer to a character that takes 2 or up to 4 bytes.
  • 8-bit-char character: used to refer to a character that takes 1 byte.
  • Function: used to refer to C/C++ functions, including class instance functions or static functions
  • Function argument: used to refer to parameters declared in function
  • Destroy / delete: used to refer to the operation that deallocate a C++ object.
    delete [] nameList; //Delete the array of C strings
    delete pRectangle; //Destroy the OGRectangle instance
  • Abstract function: used to refer to a pure virtual function in a class.
    virtual void drawRect(int x, int y, int width, int height, unsigned int color, int transparency = 0, int lineThickness = 1) = 0;
  • Abstract class: used to refer to a class with at least one pure virtual function.
    class MyAbstractClass //Interface defines a pointing device event listener.
    {
    public:
    virtual void function1(); //Virtual function
    virtual void function2(); //Virtual function
    virtual void function3() = 0; //Pure virtual function
    };
  • Interface: used to refer to a class with only pure virtual functions.
    class MouseListener //Interface defines a pointing device event listener.
    {
    public:
    virtual void handleMouseEvent(Window * window, int eventId, int keyIndicator, int x, int y) = 0;
    };
  • Interface implementation: used to refer to a class that implements all pure virtual functions of an interface
    class MouseListener //Interface defines a pointing device event listener.
    {
    public:
    virtual void handleMouseEvent(Window * window, int eventId, int keyIndicator, int x, int y)
    {
    ... //The implementation that responds to mouse event
    }
    };
  • OGTemplate: used to refer to a Pooka SDK®'s proprietary template that generates OGCanvas } content once loaded. For detailed information, read OmniGTemplate Reference.
    pageSetting = type:PageSetting, defaultTextColor:(255;200;100), defaultTextColorBright:(100;255;200)
    #==========================================================
    MainMenu = type:SceneSprite, pos:(CENTER;CENTER), size:(VIRTUAL_SCREEN_SHORT_SIDE;VIRTUAL_SCREEN_SHORT_SIDE), \
    navigationMode:TAB_MODE, highlightFocusedItem:TRUE
    sptBkg = type:Sprite,container:MainMenu, x:CENTER, y:CENTER, width:400, height:400, \
    texture:bkg.gif, textureTiling:TRUE
    sptRuler1 = type:Sprite, container:MainMenu, x:10, y:35, texture:ruler.png
    sptTestFrame = type:Sprite,container:MainMenu,pos:(5;5), size:(230; 230),frameColor:(0;0;250)
    sptUFO = type:Sprite,container:MainMenu,pos:(160;35), texture:ufo.gif
    sptSpaceShip = type:Sprite,container:MainMenu, pos:(10;150), texture:spaceship.gif



 Note  This document is still a draft edition and please excuse us for typos, grammar mistakes and any imprecise expression.
 Note  Numbers of external web links in this document point to articles at Wikipedia to explain technical terms or concepts. Readers should be aware that the content of these citations are subject to change and Pooka SDK® is not responsible for the correctness and accuracy of these citations. The copyright of those citations is owned by the original author. Read Wikipedia:Citing Wikipedia for more details.